<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_09) on Sat Dec 29 12:31:15 CET 2012 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>TimelineModel (gephi 0.8.2 API)</title>
<meta name="date" content="2012-12-29">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="TimelineModel (gephi 0.8.2 API)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TimelineModel.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/timeline/api/TimelineController.html" title="interface in org.gephi.timeline.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/gephi/timeline/api/TimelineModel.PlayMode.html" title="enum in org.gephi.timeline.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/timeline/api/TimelineModel.html" target="_top">Frames</a></li>
<li><a href="TimelineModel.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.gephi.timeline.api</div>
<h2 title="Interface TimelineModel" class="title">Interface TimelineModel</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">TimelineModel</span></pre>
<div class="block">Timeline model which holds timeline bounds, interval and animation flags.
 <p>
 The timeline controls the currently selected time interval, accessible in the
 <code>DynamicAPI</code>. When enabled, it maintains the time scale and the position
 of the interval.
 <p>
 It also holds configuration values for animation such as speed and step size.</div>
<dl><dt><span class="strong">Author:</span></dt>
  <dd>Julian Bilcke, Mathieu Bastian</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!--   -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineModel.PlayMode.html" title="enum in org.gephi.timeline.api">TimelineModel.PlayMode</a></strong></code>
<div class="block">Defines how the interval is moved when animating.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/gephi/timeline/api/TimelineChart.html" title="interface in org.gephi.timeline.api">TimelineChart</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineModel.html#getChart()">getChart</a></strong>()</code>
<div class="block">Returns the current timeline chart or <code>null</code> if node.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineModel.html#getCustomMax()">getCustomMax</a></strong>()</code>
<div class="block">Returns the custom max value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineModel.html#getCustomMin()">getCustomMin</a></strong>()</code>
<div class="block">Returns the custom min value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineModel.html#getIntervalEnd()">getIntervalEnd</a></strong>()</code>
<div class="block">Returns the upper bound of the interval.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineModel.html#getIntervalStart()">getIntervalStart</a></strong>()</code>
<div class="block">Returns the lower bound of the interval.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineModel.html#getMax()">getMax</a></strong>()</code>
<div class="block">Returns the max value of the time scale.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineModel.html#getMin()">getMin</a></strong>()</code>
<div class="block">Returns the min value of the time scale.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineModel.html#getPlayDelay()">getPlayDelay</a></strong>()</code>
<div class="block">Returns the play delay in milliseconds.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/gephi/timeline/api/TimelineModel.PlayMode.html" title="enum in org.gephi.timeline.api">TimelineModel.PlayMode</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineModel.html#getPlayMode()">getPlayMode</a></strong>()</code>
<div class="block">Returns the play mode.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineModel.html#getPlayStep()">getPlayStep</a></strong>()</code>
<div class="block">Returns the play step.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/gephi/dynamic/api/DynamicModel.TimeFormat.html" title="enum in org.gephi.dynamic.api">DynamicModel.TimeFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineModel.html#getTimeFormat()">getTimeFormat</a></strong>()</code>
<div class="block">Returns the current time format.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineModel.html#hasCustomBounds()">hasCustomBounds</a></strong>()</code>
<div class="block">Returns <code>true</code> if custom bounds are defined.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineModel.html#hasValidBounds()">hasValidBounds</a></strong>()</code>
<div class="block">Returns <code>true</code> if none of the min and max time values are infinity.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineModel.html#isEnabled()">isEnabled</a></strong>()</code>
<div class="block">Returns <code>true</code> if the timeline is enabled.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineModel.html#isPlaying()">isPlaying</a></strong>()</code>
<div class="block">Returns <code>true</code> if the timeline is playing.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="isEnabled()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEnabled</h4>
<pre>boolean&nbsp;isEnabled()</pre>
<div class="block">Returns <code>true</code> if the timeline is enabled. When enabled, the timeline
 is filtering the current graph.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the timeline is enabled, <code>false</code>
 otherwise</dd></dl>
</li>
</ul>
<a name="getMin()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMin</h4>
<pre>double&nbsp;getMin()</pre>
<div class="block">Returns the min value of the time scale. This is the start of the earliest interval
 in the workspace.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the min</dd></dl>
</li>
</ul>
<a name="getMax()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMax</h4>
<pre>double&nbsp;getMax()</pre>
<div class="block">Returns the max value of the time scale. This is the end of the latest interval
 in the workspace.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the max</dd></dl>
</li>
</ul>
<a name="getCustomMin()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCustomMin</h4>
<pre>double&nbsp;getCustomMin()</pre>
<div class="block">Returns the custom min value. This value can't be inferior than <code>min</code></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the custom min</dd></dl>
</li>
</ul>
<a name="getCustomMax()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCustomMax</h4>
<pre>double&nbsp;getCustomMax()</pre>
<div class="block">Returns the custom max value. This value can't be superior than <code>max</code></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the custom max</dd></dl>
</li>
</ul>
<a name="hasCustomBounds()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasCustomBounds</h4>
<pre>boolean&nbsp;hasCustomBounds()</pre>
<div class="block">Returns <code>true</code> if custom bounds are defined. Returns <code>false</code>
 when custom bounds are equal to <code>min</code> and <code>max</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if custom bounds are defined, <code>false</code>
 otherwise.</dd></dl>
</li>
</ul>
<a name="hasValidBounds()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasValidBounds</h4>
<pre>boolean&nbsp;hasValidBounds()</pre>
<div class="block">Returns <code>true</code> if none of the min and max time values are infinity.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the time scale is valid, <code>false</code>
 otherwise</dd></dl>
</li>
</ul>
<a name="getIntervalStart()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIntervalStart</h4>
<pre>double&nbsp;getIntervalStart()</pre>
<div class="block">Returns the lower bound of the interval.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the interval start</dd></dl>
</li>
</ul>
<a name="getIntervalEnd()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIntervalEnd</h4>
<pre>double&nbsp;getIntervalEnd()</pre>
<div class="block">Returns the upper bound of the interval.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the interval end</dd></dl>
</li>
</ul>
<a name="getTimeFormat()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTimeFormat</h4>
<pre><a href="../../../../org/gephi/dynamic/api/DynamicModel.TimeFormat.html" title="enum in org.gephi.dynamic.api">DynamicModel.TimeFormat</a>&nbsp;getTimeFormat()</pre>
<div class="block">Returns the current time format. Default is <code>DOUBLE</code></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the current tie</dd></dl>
</li>
</ul>
<a name="getPlayDelay()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlayDelay</h4>
<pre>int&nbsp;getPlayDelay()</pre>
<div class="block">Returns the play delay in milliseconds. Defines the time between each interval
 shift.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the play delay</dd></dl>
</li>
</ul>
<a name="getPlayStep()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlayStep</h4>
<pre>double&nbsp;getPlayStep()</pre>
<div class="block">Returns the play step. Defines how much the interval is moved at each step
 during animation. Defined in percentage of the total interval.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the play step</dd></dl>
</li>
</ul>
<a name="isPlaying()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPlaying</h4>
<pre>boolean&nbsp;isPlaying()</pre>
<div class="block">Returns <code>true</code> if the timeline is playing.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> is playing, <code>false</code> otherwise</dd></dl>
</li>
</ul>
<a name="getPlayMode()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlayMode</h4>
<pre><a href="../../../../org/gephi/timeline/api/TimelineModel.PlayMode.html" title="enum in org.gephi.timeline.api">TimelineModel.PlayMode</a>&nbsp;getPlayMode()</pre>
<div class="block">Returns the play mode. This defines how the interval is moved.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the play mode</dd></dl>
</li>
</ul>
<a name="getChart()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getChart</h4>
<pre><a href="../../../../org/gephi/timeline/api/TimelineChart.html" title="interface in org.gephi.timeline.api">TimelineChart</a>&nbsp;getChart()</pre>
<div class="block">Returns the current timeline chart or <code>null</code> if node.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the timeline chart or <code>null</code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TimelineModel.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/timeline/api/TimelineController.html" title="interface in org.gephi.timeline.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/gephi/timeline/api/TimelineModel.PlayMode.html" title="enum in org.gephi.timeline.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/timeline/api/TimelineModel.html" target="_top">Frames</a></li>
<li><a href="TimelineModel.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007-2012 <a href="http://consortium.gephi.org">Gephi Consortium</a>. All Rights Reserved.</small></p>
</body>
</html>
